home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / audio / alOpenEventQueue.z / alOpenEventQueue
Encoding:
Text File  |  2002-10-03  |  4.2 KB  |  67 lines
  1.  
  2.  
  3.  
  4. aaaallllOOOOppppeeeennnnEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee((((3333ddddmmmm))))                                    aaaallllOOOOppppeeeennnnEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      alOpenEventQueue - open an audio event queue
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  13.  
  14.      AAAALLLLeeeevvvveeeennnnttttQQQQuuuueeeeuuuueeee aaaallllOOOOppppeeeennnnEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee((((ccccoooonnnnsssstttt cccchhhhaaaarrrr ****nnnnaaaammmmeeee))))
  15.  
  16. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  17.      _n_a_m_e        An event queue _n_a_m_e is a character string describing the
  18.                  event queue. Event queue names have a maximum length of 20
  19.                  characters.
  20.  
  21.  
  22.  
  23. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  24.      aaaallllOOOOppppeeeennnnEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee((((3333ddddmmmm)))) allocates and partially initializes an audio event
  25.      queue (AAAALLLLeeeevvvveeeennnnttttQQQQuuuueeeeuuuueeee). An audio event queue is the mechanism through which
  26.      an application can be notified of system audio changes without it having
  27.      to poll.
  28.  
  29.      A single application may have multiple event queues open simultaneously.
  30.      There is, however, a system-dependent limit to the total number of audio
  31.      event queues active on a given system.
  32.  
  33.      After opening an event queue successfully, it is ready to setup for event
  34.      notification. Refer to aaaallllSSSSeeeelllleeeeccccttttEEEEvvvveeeennnnttttssss((((3333ddddmmmm)))), aaaallllDDDDeeeesssseeeelllleeeeccccttttEEEEvvvveeeennnnttttssss((((3333ddddmmmm)))), and
  35.      aaaallllGGGGeeeettttEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeeeFFFFDDDD((((3333ddddmmmm)))) for more information on how to setup an
  36.      AAAALLLLeeeevvvveeeennnnttttQQQQuuuueeeeuuuueeee.
  37.  
  38. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  39.      If successful, aaaallllOOOOppppeeeennnnEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee((((3333ddddmmmm)))) returns a non-zero AAAALLLLeeeevvvveeeennnnttttQQQQuuuueeeeuuuueeee
  40.      handle. Otherwise, aaaallllOOOOppppeeeennnnEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee((((3333ddddmmmm)))) returns a null (0) ALeventQueue
  41.      and sets an error code, which can be retrieved via oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  42.  
  43.      aaaallllOOOOppppeeeennnnEEEEvvvveeeennnnttttQQQQuuuueeeeuuuueeee((((3333ddddmmmm)))) can fail with the following error codes:
  44.  
  45.      AAAALLLL____BBBBAAAADDDD____NNNNOOOO____EEEEVVVVEEEENNNNTTTTQQQQSSSS      no audio event queues are currently available.
  46.  
  47.      AAAALLLL____BBBBAAAADDDD____OOOOUUUUTTTT____OOOOFFFF____MMMMEEEEMMMM      insufficient memory is available to allocate the
  48.                             AAAALLLLeeeevvvveeeennnnttttQQQQuuuueeeeuuuueeee.
  49.  
  50. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  51.      alCloseEventQueue(3dm), alSelectEvents(3dm), alDeselectEvents(3dm),
  52.      alGetEventQueueFD(3dm), oserror(3C)
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.